GET aliases/<domain>
Opis
Lista aliasów w obrębie danej domeny pocztowej.
Sygnatura polecenia
- Metoda żądania - GET
- Ścieżka żądania (URL PATH) - wskazanie domeny pocztowej
- Parametry żądania (QUERY_STRING) - parametry wpływające na listę wyników poprzez paginację, sortowanie, wyszukiwanie
- Ciało żądania - puste
- Ciało odpowiedzi - lista znalezionych aliów pocztowych opisanych wybranymi parametrami oraz informacja o liczbie wszystkich pasujących zasobów do zadanych warunków zapytania
Parametry ścieżki:
(string)
domain
wymagany Nazwa domeny w obrębie której znajdują się aliasy pocztowe.
wymagany Nazwa domeny w obrębie której znajdują się aliasy pocztowe.
przykładowa wartość:
demo.kei.pl
(int)
page
Numer strony, liczony od zera.
(int)
size
Ilość pobieranych wierszy w jednym zapytaniu (domyślnie 50).
(string)
search
Fraza, po której filtrowane będą wyniki zapytania.
(string)
sort
Pole, po którym wyniki mają być sortowane.
(string)
sort_dir
Kierunek sortowania wyników - rosnąco czy malejąco.
dopuszczalne wartości:
- asc: rosnąco
- desc: malejąco
Struktura odpowiedzi
"result_info":{
"total": "- liczba wszystkich znalezionych wierszy"
"fetched": "- liczba zwroconych wierszy"
}
"result_data": {
"wynik_wyszukiwania":{
}
}"Przykładowe zapytanie:
GET https://as27.demo.kei.pl/v1/aliases/demo.kei.pl?page=0&sort=sortowane_pole&search=szukana_fraza&sort_dir=asc&size=50
Przykładowa odpowiedź:
{
"result_info":{
"total":3,
"fetched":3,
"page_size":50,
"page":0
},
"result_data":{
"alias":{
"email":"alias@demo.kei.pl",
"target":"cel@demo.kei.pl",
"name":"alias",
"domain":"demo.kei.pl"
},
"testowyalias":{
"email":"testowyalias@demo.kei.pl",
"target":"celdrugi@biurolamour.pl",
"name":"testowyalias",
"domain":"demo.kei.pl"
},
"kolejnyalias":{
"email":"kolejnyalias@demo.kei.pl",
"target":"celtrzeci@demo.kei.pl",
"name":"kolejnyalias",
"domain":"demo.kei.pl"
}
}
}